package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendPunchStaffAddDTO;
import org.jsola.hr.dto.AttendPunchStaffUpdateDTO;
import org.jsola.hr.query.AttendPunchStaffQuery;
import org.jsola.hr.vo.AttendPunchStaffListVO;
import org.jsola.hr.vo.AttendPunchStaffVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤打卡参与人员")
public interface IAttendPunchStaffControllerAPI {

    /**
     * 新增考勤打卡参与人员
     * @param attendPunchStaffAddDTO 考勤打卡参与人员新增实体
     * @return 考勤打卡参与人员展示对象
     */
    @ApiOperation(value = "新增考勤打卡参与人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffAddDTO", dataType = "AttendPunchStaffAddDTO", value = "新增考勤打卡参与人员", paramType = "body")
    })
    Result<AttendPunchStaffVO> save(AttendPunchStaffAddDTO attendPunchStaffAddDTO);


    /**
     * 修改考勤打卡参与人员
     * @param attendPunchStaffUpdateDTO 考勤打卡参与人员
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤打卡参与人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffUpdateDTO", dataType = "AttendPunchStaffUpdateDTO", value = "修改考勤打卡参与人员", paramType = "body")
    })
    Result<Integer> update(AttendPunchStaffUpdateDTO attendPunchStaffUpdateDTO);




    /**
     * 删除单个考勤打卡参与人员，彻底删除
     * @param attendPunchStaffId 考勤打卡参与人员id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤打卡参与人员，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffId", dataType = "String", value = "考勤打卡参与人员id", paramType = "path")
    })
    Result<Integer> delete(String attendPunchStaffId);


    /**
     * 批量删除考勤打卡参与人员，彻底删除
     * @param attendPunchStaffIds 考勤打卡参与人员id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤打卡参与人员，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffIds", dataType = "String[]", value = "考勤打卡参与人员id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendPunchStaffIds);


    /**
     * 根据考勤打卡参与人员id查询考勤打卡参与人员详情
     * @param attendPunchStaffId 考勤打卡参与人员id
     * @return 考勤打卡参与人员详情
     */
    @ApiOperation(value="根据考勤打卡参与人员id查询考勤打卡参与人员详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffId", dataType = "String", value = "考勤打卡参与人员id", paramType = "path")
    })
    Result<AttendPunchStaffVO> findById(String attendPunchStaffId);


    /**
     * 查询考勤打卡参与人员
     * @param attendPunchStaffQuery 考勤打卡参与人员查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤打卡参与人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffQuery", dataType = "AttendPunchStaffQuery", value = "考勤打卡参与人员查询参数", paramType = "query")
    })
    Result<List<AttendPunchStaffListVO>> listAll(AttendPunchStaffQuery attendPunchStaffQuery);


     /**
     * 分页查询考勤打卡参与人员
     * @param attendPunchStaffQuery 考勤打卡参与人员查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤打卡参与人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchStaffQuery", dataType = "AttendPunchStaffQuery", value = "考勤打卡参与人员查询参数", paramType = "query")
    })
    Result<Page<AttendPunchStaffListVO>> page(AttendPunchStaffQuery attendPunchStaffQuery);


}

